package com.example.science.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;
import java.util.List;

@Configuration
//开启swagger
@EnableSwagger2
public class SwaggerConfig {
    // 定义一个@Bean来创建Docket实例
    @Bean
    public Docket createDocket() {
        // 创建一个ParameterBuilder实例用来构建全局参数
        ParameterBuilder tokenPar = new ParameterBuilder();
        List<Parameter> pars = new ArrayList<>();

        // 设置header中的token参数非必填，传空也可以
        tokenPar.name("token")  // 参数名称
                .description("登录认证token")  // 参数描述
                .modelRef(new ModelRef("string"))  // 参数类型
                .parameterType("header")  // 参数放置在请求头中
                .required(false)  // 参数是否必须
                .build();  // 构建参数
        pars.add(tokenPar.build());  // 将构建好的参数添加到列表

        // 创建Docket实例并指定文档类型为SWAGGER_2
        Docket docket = new Docket(DocumentationType.SWAGGER_2);

        // 设置API文档的基本信息
        ApiInfo apiInfo = new ApiInfoBuilder()
                .contact(new Contact("戴", "http://www.woniuxy.com", "wuyanzu@woniuxy.com"))  // API联系人信息
                .description("科特派")  // API描述
                .title("科技特派员业务")  // API标题
                .build();

        // 配置Docket对象
        docket.apiInfo(apiInfo)  // 设置文档基本信息
                .select()  // 开始选择需要扫描的接口
                .apis(RequestHandlerSelectors.basePackage("com.example.science.controller"))  // 指定扫描的基础包
                .paths(PathSelectors.any())  // 选择所有的路径
                .build()  // 结束选择
                .globalOperationParameters(pars);  // 设置全局操作参数

        return docket;  // 返回配置好的Docket实例
    }
}
